docs: establish Rspress docs as the library reference#15
Conversation
Add a v1-only Rspress documentation workspace for English and Korean guides. The npm README is now compact, while generated AI-readable markdown is exposed for agents until the public docs URL exists. Constraint: Public docs deployment URL is not available yet Constraint: Bob declaration generation must stay scoped to src Rejected: Keep README as the full reference | detailed guidance now belongs in docs site Confidence: high Scope-risk: moderate Directive: Do not let docs participate in library declaration builds Tested: yarn build Tested: yarn typecheck Tested: yarn workspace @react-native-motion-kit/swipe-deck-docs typecheck Tested: yarn workspace @react-native-motion-kit/swipe-deck-docs build Tested: yarn format:check; yarn lint; git diff --check
🦋 Changeset detectedLatest commit: 3114049 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: bd3ddc174c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| import { useEffect } from 'react'; | ||
|
|
||
| const GUIDE_SECTION_NAMES = new Set(['getting-started', 'usage']); | ||
| const INSTALL_PACKAGES = '@react-native-motion-kit/swipe-deck'; |
There was a problem hiding this comment.
The homepage installer tabs now expand from this single package name, so the generated yarn/pnpm/bun commands install only @react-native-motion-kit/swipe-deck. This package declares react-native-gesture-handler, react-native-reanimated, and react-native-worklets as peer dependencies in package.json, and the README/installation guide already tell users to install them; users copying the prominent homepage command with a package manager that does not auto-install peers will hit missing native/JS dependencies at runtime.
Useful? React with 👍 / 👎.
Wrap the button label in Text in both English and Korean programmatic action examples so copied React Native snippets do not render raw string children under Pressable. Constraint: React Native requires text strings to be rendered inside Text Rejected: Leave the inline Pressable example | copied snippet fails at runtime Confidence: high Scope-risk: narrow Tested: yarn workspace @react-native-motion-kit/swipe-deck-docs build Tested: yarn workspace @react-native-motion-kit/swipe-deck-docs typecheck Tested: yarn format; git diff --check
1 participant
Add a v1-only Rspress documentation workspace for English and Korean guides. The npm README is now compact, while generated AI-readable markdown is exposed for agents until the public docs URL exists.